package com.stock.api;

import com.stock.response.ResponseResult;
import com.stock.vo.CaptchaVO;
import com.stock.vo.LoginDTO;
import com.stock.vo.LoginVO;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author zby
 * @created 2024-06-22 22:44
 * @description 对外暴露用户接口
 */
@RequestMapping(path = "/api")
public interface UserControllerAPI {
    /**
     * 获取验证码
     *
     * @return CaptchaVO
     */
    @GetMapping(path = "/captcha")
    ResponseResult<CaptchaVO> captcha();

    /**
     * 环境测试接口
     *
     * @return String
     */
    @GetMapping(path = "/user/test")
    String getName();

    @PostMapping(path = "/login")
    ResponseResult<LoginVO> login(@RequestBody LoginDTO dto);
}
